docs: refresh scout README to house style - #25
Draft
ashpreetbedi wants to merge 1 commit into
Draft
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Author
|
🤖 Automated re-review Issues found:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed (docs only)
Rewrote README.md to the family house style — tight, skimmable, every command verified against the current code (compose.yaml, scripts/, app/main.py, scout/, evals/, example.env):
scout/contexts.py); dropped the YC RFS framing.compose.yaml(scout-db + scout-api, port 8000, hot reload).python -m scout/python -m scout contexts, verified againstscout/__main__.py). Kept both demo videos.authorization=runtime_env == "prd"in app/main.py), and the single-replica scheduler caveat. Removed the hardcodedapp/main.py:67line reference (brittle).example.env(no secret values).evals/__main__.py(wiring, default behavioral,--case,judges).feat/slack-interfacework) and other prose drift.CONTRIBUTING.md does not exist; docs/*.md checked and found current (WIKI_GIT.md already documents the GitBackend auto-detect) — no changes needed there.
Non-doc issues spotted (NOT changed in this PR)
railway.jsonsetsnumReplicas: 2whileapp/main.pyenablesscheduler=True. The AgentOS scheduler assumes a single replica — with 2 replicas scheduled tasks can fire twice. README now documents the caveat, but the config itself may wantnumReplicas: 1(or a leader-election story).example.env(wiki section, ~line 66): says "Then update_create_knowledge_wiki()in scout/contexts.py" — obsolete since the GitBackend auto-detect landed (89090b5). Left untouched to keep this PR strictly docs; trivially fixable in the open bump PR or a follow-up.requirements.txtpinsagno==2.6.4; the README's "agno 2.7 requires JWT_VERIFICATION_KEY at prod boot" claim anticipates the openchore/update-*bump PR. Worth double-checking the wording lands after/with that bump.🤖 Generated with Claude Code